Formal Parameter | Type | Default | Required | Description |
appliesTo | STRING | false | This parameter informs the javascript the id of the bone the actions of this component applies to. For example, action of a Toolbar will be applied to the "grid" bone (in the Report page), or the the rwb_viewer (in the document's page). Possible values for this property are bone ids, its usage depends on the page. |
|
contextMenus | STRING | false | This formal parameter is used by the Transform to identify the context-menus definition. The value of this parameter can specify either:
|
|
cssPrefix | STRING | false | Prefix to append to all css class names. |
|
datamartImage | STRING | datamart_big.gif | false | Deprecated. The image is now defined by css class name Name of the image used to display when overwriting a datamart report subscription. If you have a subscription to a grid report and if you try to create a new subscription to the same report with the same schedule, then we will show you an overwrite confirm message along with this image. |
debugErrorFlags | INTEGER | 65535 | false | Indicates which extra debug information to include in case of an error. The flags are taken from the EnumWebAppDebugFlags enumeration. |
debugFlags | INTEGER | 0 | false | Indicates which debug information to include. The flags are taken from the EnumWebAppDebugFlags enumeration. |
documentImage | STRING | document_big.gif | false | Deprecated. The image is now defined by css class name Name of the image used to display when overwriting a document subscription. If you have a subscription to a document and if you try to create a new subscription to the same document with the same schedule, then we will show you an overwrite confirm message along with this image. |
dragMode | INTEGER | 0 | false | Indicates the drag mode that the component to render will have. Usage: This tells us if the dialog can be dragged or docked (or both). Possible values for this property and their meaning include: |
extraInput | STRING | false | Indicates any extra inputs to be included in the forms generated by the transform. |
|
extraUrl | STRING | false | Indicates any extra parameters to be included in the links generated by the transform. |
|
globalCssErrorMessage | STRING | error-message | false | Deprecated. The css class to use for the title cannot be controlled by a Formal Parameter anymore. CSS to be used in all error messages. |
globalCssErrorTitle | STRING | error-title | false | Deprecated. The css class to use for the title cannot be controlled by a Formal Parameter anymore. CSS to be used in all Error titles. |
graphImage | STRING | graph_big.gif | false | Deprecated. The image is now defined by css class name Name of the image used to display when overwriting a graph report subscription. If you have a subscription to a graph report and if you try to create a new subscription to the same report with the same schedule, then we will show you an overwrite confirm message along with this image. |
gridGraphImage | STRING | gridGraphIconForHelp.gif | false | Deprecated. The image is now defined by css class name Name of the image used to display when overwriting a grid-graph report subscription. If you have a subscription to a grid-graph report and if you try to create a new subscription to the same report with the same schedule, then we will show you an overwrite confirm message along with this image. |
gridImage | STRING | report_big.gif | false | Deprecated. The image is now defined by css class name Name of the image used to display when overwriting a grid report subscription. If you have a subscription to a grid report and if you try to create a new subscription to the same report with the same schedule, then we will show you an overwrite confirm message along with this image. |
height | STRING | false | Indicates the default height of the component. If this is not a resizable component, this
is the height used. If if it resizable, though, the user might change its width
using javascript and the value is saved in a preference; thereafter the Transform
will use this new value for this component. |
|
iframeEnabled | BOOLEAN | false | false | Indicates whether the transform supports iframe manipulations. |
imgWait | STRING | ani_wait.gif | false | Deprecated. This value is not used anymore by the Transform as the wait image is included using css. Name of the image for the Processing icon on the Wait page. Allowed Values: The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter. |
initialIndent | INTEGER | 0 | false | Deprecated. Indentation is not appended by Transforms anymore. Indicates the initial indentation of the HTML generated. |
objectInfoStyle | STRING | SubsObjectInfoStyle | false | Formal parameter: Indicate which style should be used for rendering the object information |
orientation | INTEGER | 2 | false | Indicates the orientation the dialog to render will have. Usage: Possible values for this property and their meaning include: |
orientationsAllowed | INTEGER | 3 | false | Indicates the orientation modes allowed for the dialog to render. Usage: Possible values for this property and their meaning include: |
resizeLevel | INTEGER | 0 | false | Indicates whether the component can be resized vertically/horizontally or both or none.
Possible values are AbstractAppTransform.RESIZE_NONE , AbstractAppTransform.RESIZE_VERTICAL , AbstractAppTransform.RESIZE_HORIZONTAL ,
AbstractAppTransform.RESIZE_ALL |
rwDocumentImage | STRING | rwdocument_big.gif | false | Deprecated. The image is now defined by css class name Name of the image used to display when overwriting a document subscription. If you have a subscription to a document and if you try to create a new subscription to the same document with the same schedule, then we will show you an overwrite confirm message along with this image. |
scriptClass | STRING | false | Holds the name of the javaScript class (if any) to be associated with the component.
When the scriptClass is specified, a bone is registered on the page for this component.
A bone is the corresponding concept of a bean in Microstrategy's javascript environment. By default, thie methods returns an empty string. Transform which does have an associated bone needs to override this method. |
|
type | STRING | false | This parameter is used when the output of this Transform generates a corresponding Microstrategy bone in the page, and it informs the javascript the type of bone it is. For example, action of a Toolbar will be applied to the "grid" bone (in the Report page), or the the rwb_viewer (in the document's page). Possible values for this property are bone ids, its usage depends on the page. |
|
useDHTML | BOOLEAN | true | false | Indicates whether to use DHTML on the output. If not set, the bean's OutputFormat() method will be used. |
width | STRING | false | Indicates the default width of the component. If this is not a resizable component, this
is the width used. If if it resizable, though, the user might change its width
using javascript and the value is saved in a preference; thereafter the Transform
will use this new value for this component. |